Data

@Serializable
data class Data(val type: String, val data: JsonElement, val providerMetadata: Map<String, JsonElement>? = null, val id: String? = null, val transient: Boolean = false) : UIMessagePart

Typed custom data part. Mirrors v6 data-* UI parts while using an explicit type string instead of TypeScript literal keys.

Constructors

Link copied to clipboard
constructor(type: String, data: JsonElement, providerMetadata: Map<String, JsonElement>? = null, id: String? = null, transient: Boolean = false)

Properties

Link copied to clipboard
val data: JsonElement
Link copied to clipboard
val id: String?

Optional stable id. Streaming data parts that share an id replace the prior one in place (e.g. a progress indicator that updates) rather than appending a duplicate — matching v6's keyed data parts.

Link copied to clipboard
val providerMetadata: Map<String, JsonElement>?
Link copied to clipboard

Transient parts are shown live but not meant to be persisted in stored message history. Mirrors v6's transient data-chunk flag.

Link copied to clipboard

Functions

Link copied to clipboard